---
layout: m1x_soap
title: Order List
---

<h2><a name="sales_order.list-Module%3AMageSales"></a>Module: Mage_Sales</h2>


<h4><a name="sales_order.list-Resource%3Asalesorder"></a>Resource: sales_order</h4>

<p><b>Aliases</b>:</p>
<ul>
	<li>order</li>
</ul>


<h5><a name="sales_order.list-Method%3A"></a>Method:</h5>

<ul>
	<li>sales_order.list (SOAP V1)</li>
	<li>salesOrderList (SOAP V2)</li>
</ul>


<p>Allows you to retrieve the list of orders. Additional filters can be applied.</p>

<p><b>Aliases</b>:</p>
<ul>
	<li>order.list</li>
	<li>salesOrderList (SOAP V2 method name)</li>
</ul>



<p><b>Arguments</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> array </td>
<td> filters </td>
<td> Array of filters for the list of sales orders (optional) </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of salesOrderEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_id <br class="atl-forced-newline" /> </td>
<td> Store ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_active <br class="atl-forced-newline" /> </td>
<td> Defines whether the order is active </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_id <br class="atl-forced-newline" /> </td>
<td> Customer ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_amount <br class="atl-forced-newline" /> </td>
<td> Tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_amount <br class="atl-forced-newline" /> </td>
<td> Shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> discount_amount <br class="atl-forced-newline" /> </td>
<td> Discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> subtotal <br class="atl-forced-newline" /> </td>
<td> Subtotal sum </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> grand_total <br class="atl-forced-newline" /> </td>
<td> Grand total sum </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_paid <br class="atl-forced-newline" /> </td>
<td> Total paid </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_refunded <br class="atl-forced-newline" /> </td>
<td> Total refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_qty_ordered <br class="atl-forced-newline" /> </td>
<td> Total quantity ordered </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_canceled <br class="atl-forced-newline" /> </td>
<td> Total canceled </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_invoiced <br class="atl-forced-newline" /> </td>
<td> Total invoiced </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_online_refunded <br class="atl-forced-newline" /> </td>
<td> Total online refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_offline_refunded <br class="atl-forced-newline" /> </td>
<td> Total offline refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_amount <br class="atl-forced-newline" /> </td>
<td> Base shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_discount_amount <br class="atl-forced-newline" /> </td>
<td> Base discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_subtotal <br class="atl-forced-newline" /> </td>
<td> Base subtotal </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_grand_total <br class="atl-forced-newline" /> </td>
<td> Base grand total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_paid <br class="atl-forced-newline" /> </td>
<td> Base total paid </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_refunded <br class="atl-forced-newline" /> </td>
<td> Base total refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_qty_ordered <br class="atl-forced-newline" /> </td>
<td> Base total quantity ordered </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_canceled <br class="atl-forced-newline" /> </td>
<td> Base total canceled </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_invoiced <br class="atl-forced-newline" /> </td>
<td> Base total invoiced </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_online_refunded <br class="atl-forced-newline" /> </td>
<td> Base total online refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_total_offline_refunded <br class="atl-forced-newline" /> </td>
<td> Base total offline refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_address_id <br class="atl-forced-newline" /> </td>
<td> Billing address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_firstname <br class="atl-forced-newline" /> </td>
<td> First name in the billing address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_lastname <br class="atl-forced-newline" /> </td>
<td> Last name in the billing address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_address_id <br class="atl-forced-newline" /> </td>
<td> Shipping address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_firstname <br class="atl-forced-newline" /> </td>
<td> First name in the shipping address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_lastname <br class="atl-forced-newline" /> </td>
<td> Last name in the shipping address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_name <br class="atl-forced-newline" /> </td>
<td> Billing name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_name <br class="atl-forced-newline" /> </td>
<td> Shipping name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_base_rate <br class="atl-forced-newline" /> </td>
<td> Store to base rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Store to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_global_rate <br class="atl-forced-newline" /> </td>
<td> Base to global rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Base to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weight <br class="atl-forced-newline" /> </td>
<td> Weight </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_name <br class="atl-forced-newline" /> </td>
<td> Store name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> remote_ip <br class="atl-forced-newline" /> </td>
<td> Remote IP </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> status <br class="atl-forced-newline" /> </td>
<td> Order status </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> state <br class="atl-forced-newline" /> </td>
<td> Order state </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> applied_rule_ids <br class="atl-forced-newline" /> </td>
<td> Applied rule IDs </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> global_currency_code <br class="atl-forced-newline" /> </td>
<td> Global currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_currency_code <br class="atl-forced-newline" /> </td>
<td> Base currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_currency_code <br class="atl-forced-newline" /> </td>
<td> Store currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_currency_code <br class="atl-forced-newline" /> </td>
<td> Order currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_method <br class="atl-forced-newline" /> </td>
<td> Shipping method </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_description <br class="atl-forced-newline" /> </td>
<td> Shipping description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_email <br class="atl-forced-newline" /> </td>
<td> Email address of the customer </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_firstname <br class="atl-forced-newline" /> </td>
<td> Customer first name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_lastname <br class="atl-forced-newline" /> </td>
<td> Customer last name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> quote_id <br class="atl-forced-newline" /> </td>
<td> Shopping cart ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_virtual <br class="atl-forced-newline" /> </td>
<td> Defines whether the product is a virtual one </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_group_id <br class="atl-forced-newline" /> </td>
<td> Customer group ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_note_notify <br class="atl-forced-newline" /> </td>
<td> Customer notification </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_is_guest <br class="atl-forced-newline" /> </td>
<td> Defines whether the customer is a guest </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> email_sent <br class="atl-forced-newline" /> </td>
<td> Defines whether the email notification is sent </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> Order ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gift_message_id <br class="atl-forced-newline" /> </td>
<td> Gift message ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gift_message <br class="atl-forced-newline" /> </td>
<td> Gift message </td>
</tr>
</tbody></table>



<h4><a name="sales_order.list-Examples"></a>Examples</h4>

<h5><a name="sales_order.list-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires API authentication,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'order.list');
var_dump ($result);</pre>
		</div>
</div></div>

<h5><a name="sales_order.list-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$params = array(array(
            'filter' =&gt; array(
                array(
                    'key' =&gt; 'status',
                    'value' =&gt; 'pending'
                ),
                array(
                    'key' =&gt; 'created_at',
                    'value' =&gt; '2001-11-25 12:12:07',
                )
            ),
            'complex_filter' =&gt; array(
                array(
                    'key' =&gt; 'order_id',
                    'value' =&gt; array(
                        'key' =&gt; 'in',
                        'value' =&gt; '12,23'
                    ),
                ),
                array(
                    'key' =&gt; 'protect_code',
                    'value' =&gt; array(
                        'key' =&gt; 'eq',
                        'value' =&gt; 'ebb2a0'
                    ),
                ),
            )
        ));

$result = $client-&gt;__call('salesOrderList', $params);</pre>
		</div>
</div></div>


<h5><a name="sales_order.list-RequestExampleSOAPV2%28SimpleFilter%29"></a>Request Example SOAP V2 (Simple Filter)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

// If some stuff requires API authentication,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');
$filter = array('filter' =&gt; array(array('key' =&gt; 'status', 'value' =&gt; 'closed')));
$result = $client-&gt;salesOrderList($session, $filter);

var_dump ($result);</pre>
		</div>
</div></div>

<h5><a name="sales_order.list-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;salesOrderList((object)array('sessionId' =&gt; $sessionId-&gt;result, 'filters' =&gt; null));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>



<h5><a name="sales_order.list-XMLSOAPV2Example"></a>XML SOAP V2 Example</h5>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>SOAP "v2" XML Request</b></div><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: html/xml; gutter: false">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:Magento"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"&gt;
    &lt;SOAP-ENV:Body&gt;
        &lt;ns1:salesOrderList&gt;
            &lt;sessionId xsi:type="xsd:string"&gt;abbc417256a3ffb93d130a77a2fd3665&lt;/sessionId&gt;
            &lt;filters xsi:type="ns1:filters"&gt;
                &lt;filter SOAP-ENC:arrayType="ns1:associativeEntity[2]" xsi:type="ns1:associativeArray"&gt;
                    &lt;item xsi:type="ns1:associativeEntity"&gt;
                        &lt;key xsi:type="xsd:string"&gt;status&lt;/key&gt;
                        &lt;value xsi:type="xsd:string"&gt;pending&lt;/value&gt;
                    &lt;/item&gt;
                    &lt;item xsi:type="ns1:associativeEntity"&gt;
                        &lt;key xsi:type="xsd:string"&gt;created_at&lt;/key&gt;
                        &lt;value xsi:type="xsd:string"&gt;2011-11-29 15:41:11&lt;/value&gt;
                    &lt;/item&gt;
                &lt;/filter&gt;
                &lt;complex_filter SOAP-ENC:arrayType="ns1:complexFilter[2]" xsi:type="ns1:complexFilterArray"&gt;
                    &lt;item xsi:type="ns1:complexFilter"&gt;
                        &lt;key xsi:type="xsd:string"&gt;order_id&lt;/key&gt;
                        &lt;value xsi:type="ns1:associativeEntity"&gt;
                            &lt;key xsi:type="xsd:string"&gt;in&lt;/key&gt;
                            &lt;value xsi:type="xsd:string"&gt;Array&lt;/value&gt;
                        &lt;/value&gt;
                    &lt;/item&gt;
                    &lt;item xsi:type="ns1:complexFilter"&gt;
                        &lt;key xsi:type="xsd:string"&gt;protect_code&lt;/key&gt;
                        &lt;value xsi:type="ns1:associativeEntity"&gt;
                            &lt;key xsi:type="xsd:string"&gt;in&lt;/key&gt;
                            &lt;value xsi:type="xsd:string"&gt;a4ffa8&lt;/value&gt;
                        &lt;/value&gt;
                    &lt;/item&gt;
                &lt;/complex_filter&gt;
            &lt;/filters&gt;
        &lt;/ns1:salesOrderList&gt;
    &lt;/SOAP-ENV:Body&gt;
&lt;/SOAP-ENV:Envelope&gt;</pre>
		</div>
</div></div>


